Node / meshtastic / Meshtastic-Android / files / docs / README.md

Displaying Raw • View rendered • Download

Tc9d1d9# Documentation Structure

This directory contains the source documentation for the Meshtastic Android/Desktop/iOS app.

It serves three consumers:

Tff7b721. **In-app docs browser** — bundled via Compose Resources at build time

Tff7b722. **Jekyll site** — GitHub Pages (this directory is the Jekyll source root)

Tff7b723. **meshtastic.org** — Docusaurus sync (upstream consumption)

Tc9d1d9## Locale Layout

Ta5d6ff```

docs/

├── _config.yml, _data/, _layouts/, _sass/ ← Jekyll site infrastructure

├── en/ ← English source (edit here)

│ ├── user/ ← User Guide pages

│ ├── developer/ ← Developer Guide pages

│ ├── index.md ← Site home page

│ ├── user.md ← User Guide nav parent

│ └── developer.md ← Developer Guide nav parent

├── fr-rFR/ ← French (Crowdin-generated)

│ └── user/ ← Translated user guide

├── de-rDE/ ← German (Crowdin-generated)

│ └── user/

└── ... ← Other locales

```

Tc9d1d9## Editing Guidelines

Tff7b72- **English source**: Edit files under Ta5d6ff`docs/en/`. These are the authoritative source.

Tff7b72- **Translations**: Do **not** edit files in locale folders directly. They are auto-generated

by [Tff7b72Crowdin](Te6edf3https://crowdin.com/project/meshtastic-android) and will be overwritten on sync.

Contribute translations via Crowdin instead.

Tff7b72- **Adding a page**: Create the Ta5d6ff`.md` file in Ta5d6ff`docs/en/user/` or Ta5d6ff`docs/en/developer/`, then

register it in Ta5d6ff`feature/docs/.../DocBundleLoader.kt` for in-app bundling.

Tc9d1d9## How Translations Work

Tff7b721. English source files (Ta5d6ff`docs/en/user/*.md`) are uploaded to Crowdin as translation sources

Tff7b722. Volunteers translate via the Crowdin web UI

Tff7b723. Crowdin PRs land translated files at Ta5d6ff`docs/{android_code}/user/*.md` (e.g., Ta5d6ff`fr-rFR`, Ta5d6ff`pt-rBR`)

Tff7b724. At build time, the Gradle Ta5d6ff`syncTranslatedDocsToComposeResources` task bundles them into

locale-qualified Compose Resources for the in-app reader

Tff7b725. The in-app Ta5d6ff`DocBundleLoader` tries the user's locale first, then falls back to English